Skip to content

Circuit breaker changes using pybreaker #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Circuit breaker changes using pybreaker #705

wants to merge 19 commits into from

Conversation

@nikhilsuri-db
Copy link
Contributor

@nikhilsuri-db nikhilsuri-db commented Nov 4, 2025 •
edited
Loading

What type of PR is this?

  • Refactor
  • Feature
  • Bug Fix
  • Other

Description

This PR introduces a circuit breaker pattern to the telemetry system to prevent cascading failures and improve system resilience. The implementation uses the pybreaker library to monitor telemetry request failures and automatically open the circuit when failure rates exceed configurable thresholds, blocking further requests to protect downstream services. When the circuit is open, telemetry requests are temporarily blocked until the system recovers, at which point the circuit transitions to half-open for testing and eventually closes when normal operation resumes. The circuit breaker configuration is centralized with immutable settings, includes comprehensive logging for monitoring, and maintains full backward compatibility with existing telemetry functionality.

How is this tested?

  • Unit tests
  • E2E Tests
  • Manually
  • N/A

Related Tickets & Documents

https://docs.google.com/document/d/1ftRvby9bwDZzE3s1tOb4hJ4Pd9USiXskb9cDw-uQNPM/edit?usp=sharing

@nikhilsuri-db nikhilsuri-db self-assigned this Nov 4, 2025
@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

@nikhilsuri-db
circuit breaker changes using pybreaker
db93974 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
Added interface layer top of http client to use circuit rbeaker
1f9c4d3 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
Added test cases to validate ciruit breaker
939b548 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
fixing broken tests
6c72f86 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
fixed linting issues
ac845a5 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
fixed failing test cases
a602c39 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
fixed urllib3 issue
c1b6e25 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
added more test cases for telemetry
e3d85f4 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
simplified CB config
9dfb623 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
poetry lock
e7e8b4b 
Signed-off-by: Nikhil Suri <[email protected]>
nikhilsuri-db
nikhilsuri-db commented Nov 6, 2025
View reviewed changes
src/databricks/sql/telemetry/circuit_breaker_manager.py
)


class CircuitBreakerStateListener(CircuitBreakerListener):
Copy link
Contributor Author

@nikhilsuri-db nikhilsuri-db Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only used for logging purposed for now

nikhilsuri-db
nikhilsuri-db commented Nov 6, 2025
View reviewed changes
src/databricks/sql/telemetry/circuit_breaker_manager.py Outdated
logger = logging.getLogger(__name__)

# Circuit Breaker Configuration Constants
MINIMUM_CALLS = 20
Copy link
Contributor Author

@nikhilsuri-db nikhilsuri-db Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hardcoded values as do not want user to configure them anywhere in the driver

@nikhilsuri-db
linting issue fixed
b527e7c 
Signed-off-by: Nikhil Suri <[email protected]>
@github-actions
Copy link

github-actions bot commented Nov 11, 2025

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

nikhilsuri-db
nikhilsuri-db commented Nov 11, 2025
View reviewed changes
pyproject.toml
{ version = ">=18.0.0", python = ">=3.13", optional=true }
]
pyjwt = "^2.0.0"
pybreaker = "^1.0.0"
Copy link
Contributor Author

@nikhilsuri-db nikhilsuri-db Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vikrantpuppala Can we be sure that adding new library won't break any other client usage?

src/databricks/sql/auth/common.py
pool_connections: Optional[int] = None,
pool_maxsize: Optional[int] = None,
user_agent: Optional[str] = None,
telemetry_circuit_breaker_enabled: Optional[bool] = None,
Copy link
Contributor Author

@nikhilsuri-db nikhilsuri-db Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should remove it from here and instead set this using a safe flag. @gopalldb what was the rolloutplan for CB in java?

src/databricks/sql/common/unified_http_client.py
logger.error("HTTP request failed after retries: %s", e)
raise RequestError(f"HTTP request failed: {e}")

# Try to extract HTTP status code from the MaxRetryError
Copy link
Contributor Author

@nikhilsuri-db nikhilsuri-db Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

setting http_code here which will be used by CircuitBreaker to consider regression in telemetry endpoint

src/databricks/sql/telemetry/circuit_breaker_manager.py


@dataclass(frozen=True)
class CircuitBreakerConfig:
Copy link
Contributor Author

@nikhilsuri-db nikhilsuri-db Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Single object to store CB config

src/databricks/sql/telemetry/circuit_breaker_manager.py
return breaker

@classmethod
def _create_noop_circuit_breaker(cls) -> CircuitBreaker:
Copy link
Contributor Author

@nikhilsuri-db nikhilsuri-db Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In cases where client config setup failed or used by test cases.

@nikhilsuri-db
raise CB only for 429/503
2b45814 
Signed-off-by: Nikhil Suri <[email protected]>
@nikhilsuri-db
fix broken test cases
1193af7 
Signed-off-by: Nikhil Suri <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@samikshya-db samikshya-db Awaiting requested review from samikshya-db

At least 1 approving review is required to merge this pull request.

Assignees

@nikhilsuri-db nikhilsuri-db

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nikhilsuri-db